home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / BROWSERS / AIRC_063 / ATARIRC.DOC < prev    next >
Encoding:
Text File  |  1996-11-10  |  13.7 KB  |  361 lines
  1. AtarIRC Documentation
  2. ---------------------
  3. Coded by Lonny L Pursell
  4. (C)1996 by Lonny L Pursell and ENCOM
  5. All rights reserved.
  6.  
  7. ** FreeWare **
  8.  
  9.  
  10. Disclaimer
  11. ----------
  12. Use entirely at your own risk!
  13.  
  14.  
  15. Support
  16. -------
  17. This program is FreeWare.  This program is fully functional and there
  18. are no disabled features or software keys required to use it.  You
  19. need not send me anything, however any donations will be accepted.
  20.  
  21. Contact:
  22.  
  23. Lonny Pursell
  24. 101 1/2 S High Street  Apt C
  25. Columbus Grove  OH  45830
  26. USA
  27.  
  28. E-Mail: atari@bright.net
  29.    WWW: http://www.bright.net/~atari/
  30.    IRC: lp @ #Atari
  31.  
  32. When reporting bugs please include the version number and a
  33. _detailed_ description of your system setup.
  34.  
  35. Note: I do not have the time or desire to blindly track what
  36. looks like bugs on non-Atari hardware.  If this program fails
  37. on an emulator I suggest you either don't use this program or
  38. get a real computer.
  39.  
  40.  
  41. Credits
  42. -------
  43. I'd like to thank...
  44.   All the beta testers.
  45.   All the people who sent me e-mail regarding the program.
  46.                    
  47.  
  48. IRC Client Information
  49. ----------------------
  50. A channel on IRC is referenced with the '#' in front of it.  The
  51. Atari channel would be refered to as '#Atari' in all related IRC
  52. commands.  Note that #Atari is the same as #atari.
  53.  
  54. Anything entered into the IRC client starting with a '/' is
  55. interpreted as a command, otherwise it's echoed to the current
  56. channel for all to see.
  57.  
  58. All commands not listed below are sent to the server just as you typed
  59. them.  The IRC client doesn't interpret them at all so any error
  60. messages you see are server generated.  An example would be '/whois
  61. nick' which is a server command and thus not interpreted by the client
  62. at all.  Only commands interpreted by the client are listed below.
  63.  
  64.  
  65. Misc Info
  66. ---------
  67. Supports a maximum of 10 simultaneous sessions in any combination
  68. where a single session could be a channel, a DCC file operation, or a
  69. DCC chat.  If ran in a mode with more than 16 colors then only the
  70. first 16 colors are used.  Sound is supported but only on machines
  71. which are equiped with DMA sound capabilities.
  72.  
  73.  
  74. Command List
  75. ------------
  76. /AWAY
  77.   '/away' marks you as being away and displays the default message
  78.   '/away message' marks you as being away and displays 'message' 
  79.   when on a clock symbol appears in the window info line
  80.   only the current channel is notified that you are marked as away
  81. /BYE
  82.   same as /quit
  83. /BACK
  84.   '/back' turns away off and uses the default message
  85.   '/back message' turns away off and uses 'message'
  86.   only the current channel is notified when you return
  87. /BAN
  88.   '/ban' shows a list of bans for the current channel
  89.   '/ban mask' will set a ban for 'mask' on the current channel
  90. /CAPTURE
  91.   '/capture' display capture file size in bytes
  92.   when on a 'c' in a circle appears in the window info line
  93.   all text shown in the scrolling area will be captured
  94.   when the limit is reached a bell sounds and capture is turned off
  95. /CD
  96.   '/cd' displays the current path
  97.   '/cd path' sets the 'path' on the current drive
  98.   '/cd \' sets the path to the root of the current drive
  99.   '/cd ..' backs up one folder on the current drive
  100. /CHDRIVE
  101.   '/chdrive' displays the current drives
  102.   '/chdrive d' set the current drive to 'd'
  103. /CLIENTINFO
  104.   '/clientinfo' request clinetinfo from everyone in the current channel
  105.   '/clientinfo nick' sends a clientinfo request to 'nick'
  106.   '/clientinfo #channel' request clientinfo from everyone in '#channel'
  107. /CONNECT
  108.   '/connect' attempt connection to default server and port
  109.   '/connect i' attempt connection to 'i' from the server list
  110.   '/conncet server' attempt connection to 'server' on default port
  111.   '/conncet server port' attempt connection to 'server' on 'port'
  112.   note: a valid /connect command can be passed as a parameter at start up
  113. /CTCP nick message
  114.   '/ctcp nick' defaults to '/ctcp nick version'
  115.   '/ctcp nick message' sends a ctcp 'message' to 'nick'
  116.   the 'message' will be converted to uppercase
  117.   ctcp returns 'errmsg' in reply to unsupported ctcp commands
  118. /DCC
  119.   '/dcc' same as '/dcc list'
  120.   '/dcc list' shows status of current dcc connections and channels
  121.   '/dcc close' closes current dcc connection window
  122.   '/dcc chat nick' starts a private chat session with 'nick'
  123.   '/dcc send nick' send 'nick' a file via the file selector
  124.   '/dcc send nick file' send 'nick' a 'file'
  125.   if the remote end doesn't send the file size it displays '-1' instead
  126. /DEBUG
  127.   '/debug' shows conenction data which is all in $hex
  128.   '/debug #' where '#' is a number from 0 to 9 for debug level (0=off)
  129.     currently only levels 1 and 2 are used
  130.   '/debug on' begins data logging (same as '/debug 1')
  131.   '/debug off' stops data logging (same as '/debug 0')
  132.   '/debug mem' show free memory status
  133.   '/degub misc' show some internal values
  134.   '/debug history' show command line history
  135.   the log file will conatain all data going in and out of the irc client
  136.   holding the alternate key when the program starts begins logging too
  137.   a check mark appears in the window info line when debug mode is on
  138. /DEFINE
  139.   '/define' displays the current contents of all ~variables
  140.   '/define string' is used to define the variable ~user only
  141.   example: '/define lp' would set variable ~user to 'lp'
  142. /DELETE
  143.   '/delete' calls file selector
  144.   '/delete file' deletes 'file' from disk
  145.   the file will be deleted when you press return with no warning
  146. /DEOP
  147.   '/deop nick' will take operator status away from 'nick' if you are an op
  148.   more than one nick can be listed seperated by spaces
  149. /DFREE
  150.   '/dfree' returns the free bytes on the current drive
  151.   '/dfree d' returns the free bytes on drive 'd'
  152. /DIR
  153.   '/dir' lists all files in the current drive path '*.*'
  154.   '/dir mask' lists all files in the current drive path matching 'mask'
  155.   files show sizes and and folders show '<dir>' instead
  156.   press escape to abort the dir
  157. /DISCONNECT
  158.   '/disconnect' disconnects you from the server only (default quit message)
  159.   '/disconnect message' disconnects you from the server with 'message'
  160.   all dcc connections remain intact and active
  161. /ECHO
  162.   '/echo nick message' requests an echo from 'nick'
  163.   '/echo #channel message' requests an echo from everyone in '#channel'
  164. /EXIT
  165.   same as /quit
  166. /FIND
  167.   '/find data' will search the user list for 'data'
  168.   this command translates to '/who *data*'
  169. /FINGER
  170.   '/finger' fingers everyone in the current channel
  171.   '/finger nick' sends a finger request to 'nick'
  172.   '/finger #channel' sends a finger request to everyone in '#channel'
  173. /INVITE
  174.   '/invite nick' will invite 'nick' to current the channel
  175. /JOIN 
  176.   '/join' joins the default channel
  177.   '/join #channel' join IRC '#channel'
  178. /KICK
  179.   '/kick nick' remove 'nick' from current channel and display default message
  180.   '/kick nick message' remove 'nick' from current channel and display 'message'
  181. /KICKBAN
  182.   '/kickban nick' kicks and and bans 'nick' with a simple nick mask
  183.     default kick message is used
  184.   '/kickban nick mask' kicks and bans nick with specific 'mask'
  185.     default kick message is used
  186.   '/kickban nick mask message' kicks and bans 'nick' with 'mask'
  187.     'message' will be used instead of default kick message
  188. /LEAVE
  189.   same as /part
  190. /LOGOFF
  191.   same as /disconnect
  192. /LOGON
  193.   same as /connect
  194. /ME
  195.   '/me message' displays your nick followed by 'messege'
  196.   example: '/me loves Atari' displays 'lp loves Atari'
  197. /MKDIR
  198.   '/mkdir folder' creates folder 'folder' on the current drive
  199. /MSG nick message 
  200.   '/msg nick message'  sends 'nick' a private 'message'
  201.   example: '/msg lp Are we having fun yet?'
  202. /NICK nick
  203.   '/nick newnick' changes your nick to 'newnick'
  204.   a nick has a maximum of 9 characters
  205. /OP
  206.   '/op nick' will give 'nick' operator status if you are an op
  207.   more than one nick can be listed seperated by spaces
  208. /PART
  209.   '/part' leave current #channel
  210.   '/part #channel' leave a specific '#channel' 
  211. /PING
  212.   '/ping' ping everyone in the current channel
  213.   '/ping nick' ping 'nick' only
  214.   '/ping #channel' ping everyone in '#channel'
  215. /PRINT
  216.   '/print' calls file selector
  217.   '/print file.txt' sends file 'file.txt' to the line printer
  218.   press escape to abort the printing
  219. /QUIT
  220.   'quit' leave IRC and display default message (closes the IRC session)
  221.   '/quit message' leave IRC and display 'message'
  222.   example: '/QUIT I'll be back...'
  223.   ends all dcc connections that might still be active
  224.   exits the program
  225. /RENAME
  226.   'rename file1 file2' renames 'file1' to 'file2'
  227.   the file will be renamed when you press return with no warning
  228. /RMDIR
  229.   '/rmdir folder' deletes folder 'folder' on the current drive
  230.   only empty folders can be deleted
  231. /SEARCH
  232.   '/search' same as doing '/list' so be prepared to for a long list
  233.   '/search string' does a '/list' but only displays matches to 'string'
  234. /SEND
  235.   '/send' calls file selector
  236.   '/send file.txt' sends 'file.txt' to the current window
  237.   the data is sent out the modem and eched to the screen too
  238.   press escape to abort the send
  239. /SERVER
  240.   same as /connect
  241. /SOUND
  242.   '/sound nick file' sends a sound command to 'nick' to play sound 'file'
  243.   '/sound #channel file' sends the sound command to the channel
  244.   '/sound nick' calls the file selector
  245.   note: the file name is sent just as you typed it
  246. /TIME
  247.   '/time' returns the server time information
  248.   '/time nick' requests time information from 'nick'
  249.   '/time #channel' requests time information from eveyone in '#channel'
  250. /TOPIC
  251.   '/topic' displays the current channel topic
  252.   '/topic string' sets current channel topic to 'string'
  253. /UNBAN
  254.   '/unban mask' will remove the ban for 'mask' on the current channel
  255. /USERINFO
  256.   '/userinfo' request userinfo from everyone in the current channel
  257.   '/userinfo nick' sends a userinfo request to 'nick'
  258.   '/userinfo #channel' request userinfo from everyone in '#channel'
  259. /VERSION
  260.   '/version' returns the server version information
  261.   '/version nick' requests version information from 'nick'
  262.   '/version #channel' requests version information from eveyone in '#channel'
  263. /VIEW
  264.   '/view' calls file selector
  265.   '/view file' displays 'file' to the screen only
  266.   no data is sent out the modem
  267.   press escape to abort the view
  268.  
  269.  
  270. Dynamic variables
  271. -----------------
  272. Variables can be used in the command line.
  273. The following commands support variables to:
  274.   /fkey strings
  275.   /away and /back messages
  276.   /quit messages
  277.   /userinfo reply
  278.   /finger reply
  279.   /kick message
  280.   /ping message
  281.     ~nick     your current nick
  282.     ~chan     current channel (same as prompt)
  283.     ~join     last nick that entered the current channel
  284.     ~part     last nick that left the current channel
  285.     ~ping     last nick that did a /ping on you
  286.     ~finger   last nick that did a /finger on you
  287.     ~version  last nick that did a /version on you
  288.     ~msg      last nick that sent you a private /msg or you did /msg too 
  289.     ~quit     last nick that quit irc from current channel
  290.     ~kick     last nick that was kicked from the current channel
  291.     ~ctcp     last nick that sent you a /ctcp message or you did /ctcp too
  292.     ~date     current date format: mm/dd/yyyy
  293.     ~time     current time format: hh:mm:ss (24 hour clock)
  294.     ~ctime    connect time format: 00h00m00s
  295.     ~invite   last nick that sent you an invite message
  296.     ~user     user definable string
  297.     ~rnick    generates a random 9 character string to be used as a nick
  298.     ~cnick    last nick changed on any channel you might be in
  299.     ~title    irc client title
  300.     ~email    your e-mail address
  301.     ~www      your world wide web address
  302.     ~rname    your real name
  303.     ~uname    your user name
  304.     ~|        return (only one per fkey and must be on the end if used)
  305.   example: /fkey 1 my nick is ~nick and i am in channel ~chan~|
  306.     pressing f1 would display: 'my nick is lp and i am in channel #atari' 
  307.  
  308.  
  309. Misc Keys 
  310. ---------
  311. ALTERNATE    pause screen
  312.   this might help with viewing the channel /list
  313.   holding the alternate key down too long may cause data overflow?
  314. BACKSPACE    edit command line
  315. CLR HOME     clear screen
  316. CONTROL B    toggle bold text on and off
  317. CONTROL C    close the current dcc connection window
  318. CONTROL D    toggle incoming /msg bell on and off
  319.   when on a bell symbol appears in the window info line
  320. CONTROL F    toggle flood control on and off
  321.   when on the tilde char '~' appears in the window info line
  322. CONTROL K    tcp kick current window (really only good for dcc send)
  323. CONTROL L    toggle capture/logging on and off
  324.   when on a 'c' in a cirlce appears in the window info line
  325. CONTROL O    shuts all effects off
  326. CONTROL P    ping server
  327. CONTROL S    Setup/Configuration
  328.   when the /msg bell is on a bell appears in the info line
  329.   when flood control is on '~' appears in the info line
  330. CONTROL U    restore default colors (black text on a white background)
  331. CONTROL V    toggle reverse text on and off
  332. CONTROL X    toggle color/mono background redrawing
  333. CONTROL -    toggle underline text on and off
  334. DELETE       same as backspace
  335. DOWN ARROW   scroll command line history down
  336. ESCAPE       clear the command line/interrupt modem activity
  337. F1-F10       function key macro
  338. HELP         show server settings
  339. INSERT       last command recall
  340.   this only works on a blank command like
  341. LEFT ARROW   change window down one
  342. RETURN       execute command line
  343. RIGHT ARROW  change window up one
  344. SHIFT F1-F10 function key macro
  345. TAB          auto /msg reply, this types '/msg nick' for you
  346. UNDO         show function key settings
  347. UP ARROW     scroll command line history up
  348.  
  349.  
  350. Known Problems
  351. --------------
  352. For some reason certain key combinations are interpreted as
  353. though function key f13 was pressed when it was not.  To work
  354. around this minor bug do not define f13 as anything.
  355.  
  356. The identd feature seems to not function for some people.  The
  357. fix for now is to shut it off.
  358.  
  359.  
  360. eof
  361.